heartrate13 2.2.1
Loading...
Searching...
No Matches
heartrate13.h File Reference

This file contains API for Heart Rate 13 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  heartrate13_pd_data_t
 Heart Rate 13 Click photodiodes data object. More...
struct  heartrate13_t
 Heart Rate 13 Click context object. More...
struct  heartrate13_cfg_t
 Heart Rate 13 Click configuration object. More...

Macros

#define HEARTRATE13_REG_STATUS   0x00
 Heart Rate 13 register list.
#define HEARTRATE13_REG_INT_MASK   0x01
#define HEARTRATE13_REG_GPIO_DRV   0x02
#define HEARTRATE13_REG_BG_STATUS   0x04
#define HEARTRATE13_REG_FIFO_THRESH   0x06
#define HEARTRATE13_REG_DEVID   0x08
#define HEARTRATE13_REG_I2CS_ID   0x09
#define HEARTRATE13_REG_CLK_RATIO   0x0A
#define HEARTRATE13_REG_GPIO_CTRL   0x0B
#define HEARTRATE13_REG_SLAVE_ADDRESS_KEY   0x0D
#define HEARTRATE13_REG_SW_RESET   0x0F
#define HEARTRATE13_REG_MODE   0x10
#define HEARTRATE13_REG_SLOT_EN   0x11
#define HEARTRATE13_REG_FSAMPLE   0x12
#define HEARTRATE13_REG_PD_LED_SELECT   0x14
#define HEARTRATE13_REG_NUM_AVG   0x15
#define HEARTRATE13_REG_BG_MEAS_A   0x16
#define HEARTRATE13_REG_INT_SEQ_A   0x17
#define HEARTRATE13_REG_SLOTA_CH1_OFFSET   0x18
#define HEARTRATE13_REG_SLOTA_CH2_OFFSET   0x19
#define HEARTRATE13_REG_SLOTA_CH3_OFFSET   0x1A
#define HEARTRATE13_REG_SLOTA_CH4_OFFSET   0x1B
#define HEARTRATE13_REG_BG_MEAS_B   0x1C
#define HEARTRATE13_REG_INT_SEQ_B   0x1D
#define HEARTRATE13_REG_SLOTB_CH1_OFFSET   0x1E
#define HEARTRATE13_REG_SLOTB_CH2_OFFSET   0x1F
#define HEARTRATE13_REG_SLOTB_CH3_OFFSET   0x20
#define HEARTRATE13_REG_SLOTB_CH4_OFFSET   0x21
#define HEARTRATE13_REG_ILED3_COARSE   0x22
#define HEARTRATE13_REG_ILED1_COARSE   0x23
#define HEARTRATE13_REG_ILED2_COARSE   0x24
#define HEARTRATE13_REG_ILED_FINE   0x25
#define HEARTRATE13_REG_SLOTA_LED_PULSE   0x30
#define HEARTRATE13_REG_SLOTA_NUMPULSES   0x31
#define HEARTRATE13_REG_LED_DISABLE   0x34
#define HEARTRATE13_REG_SLOTB_LED_PULSE   0x35
#define HEARTRATE13_REG_SLOTB_NUMPULSES   0x36
#define HEARTRATE13_REG_ALT_PWR_DN   0x37
#define HEARTRATE13_REG_EXT_SYNC_STARTUP   0x38
#define HEARTRATE13_REG_SLOTA_AFE_WINDOW   0x39
#define HEARTRATE13_REG_SLOTB_AFE_WINDOW   0x3B
#define HEARTRATE13_REG_AFE_PWR_CFG1   0x3C
#define HEARTRATE13_REG_SLOTA_FLOAT_LED   0x3E
#define HEARTRATE13_REG_SLOTB_FLOAT_LED   0x3F
#define HEARTRATE13_REG_SLOTA_TIA_CFG   0x42
#define HEARTRATE13_REG_SLOTA_AFE_CFG   0x43
#define HEARTRATE13_REG_SLOTB_TIA_CFG   0x44
#define HEARTRATE13_REG_SLOTB_AFE_CFG   0x45
#define HEARTRATE13_REG_SAMPLE_CLK   0x4B
#define HEARTRATE13_REG_CLK32M_ADJUST   0x4D
#define HEARTRATE13_REG_EXT_SYNC_SEL   0x4F
#define HEARTRATE13_REG_CLK32M_CAL_EN   0x50
#define HEARTRATE13_REG_AFE_PWR_CFG2   0x54
#define HEARTRATE13_REG_TIA_INDEP_GAIN   0x55
#define HEARTRATE13_REG_MATH   0x58
#define HEARTRATE13_REG_FLT_CONFIG_B   0x59
#define HEARTRATE13_REG_FLT_LED_FIRE   0x5A
#define HEARTRATE13_REG_FLT_CONFIG_A   0x5E
#define HEARTRATE13_REG_DATA_ACCESS_CTL   0x5F
#define HEARTRATE13_REG_FIFO_ACCESS   0x60
#define HEARTRATE13_REG_SLOTA_PD1_16BIT   0x64
#define HEARTRATE13_REG_SLOTA_PD2_16BIT   0x65
#define HEARTRATE13_REG_SLOTA_PD3_16BIT   0x66
#define HEARTRATE13_REG_SLOTA_PD4_16BIT   0x67
#define HEARTRATE13_REG_SLOTB_PD1_16BIT   0x68
#define HEARTRATE13_REG_SLOTB_PD2_16BIT   0x69
#define HEARTRATE13_REG_SLOTB_PD3_16BIT   0x6A
#define HEARTRATE13_REG_SLOTB_PD4_16BIT   0x6B
#define HEARTRATE13_REG_A_PD1_LOW   0x70
#define HEARTRATE13_REG_A_PD2_LOW   0x71
#define HEARTRATE13_REG_A_PD3_LOW   0x72
#define HEARTRATE13_REG_A_PD4_LOW   0x73
#define HEARTRATE13_REG_A_PD1_HIGH   0x74
#define HEARTRATE13_REG_A_PD2_HIGH   0x75
#define HEARTRATE13_REG_A_PD3_HIGH   0x76
#define HEARTRATE13_REG_A_PD4_HIGH   0x77
#define HEARTRATE13_REG_B_PD1_LOW   0x78
#define HEARTRATE13_REG_B_PD2_LOW   0x79
#define HEARTRATE13_REG_B_PD3_LOW   0x7A
#define HEARTRATE13_REG_B_PD4_LOW   0x7B
#define HEARTRATE13_REG_B_PD1_HIGH   0x7C
#define HEARTRATE13_REG_B_PD2_HIGH   0x7D
#define HEARTRATE13_REG_B_PD3_HIGH   0x7E
#define HEARTRATE13_REG_B_PD4_HIGH   0x7F
#define HEARTRATE13_SAMPLE_CLK_RESERVED   0x2600u
 Heart Rate 13 SAMPLE_CLK register settings.
#define HEARTRATE13_SAMPLE_CLK_CLK32K_BYP_MASK   0x0100u
#define HEARTRATE13_SAMPLE_CLK_CLK32K_EN_MASK   0x0080u
#define HEARTRATE13_SAMPLE_CLK_CLK32K_ADJUST_MASK   0x003Fu
#define HEARTRATE13_INT_MASK_RESERVED   0x009Fu
 Heart Rate 13 INT_MASK register settings.
#define HEARTRATE13_INT_MASK_FIFO_INT_MASK   0x0100u
#define HEARTRATE13_INT_MASK_SLOTB_INT_MASK   0x0040u
#define HEARTRATE13_INT_MASK_SLOTA_INT_MASK   0x0020u
#define HEARTRATE13_GPIO_DRV_GPIO1_DRV_MASK   0x0200u
 Heart Rate 13 GPIO_DRV register settings.
#define HEARTRATE13_GPIO_DRV_GPIO1_POL_MASK   0x0100u
#define HEARTRATE13_GPIO_DRV_GPIO0_ENA_MASK   0x0004u
#define HEARTRATE13_GPIO_DRV_GPIO0_DRV_MASK   0x0002u
#define HEARTRATE13_GPIO_DRV_GPIO0_POL_MASK   0x0001u
#define HEARTRATE13_SLOT_EN_RDOUT_MODE_MASK   0x2000u
 Heart Rate 13 SLOT_EN register settings.
#define HEARTRATE13_SLOT_EN_FIFO_OVRN_PREVENT_MASK   0x1000u
#define HEARTRATE13_SLOT_EN_SLOTB_FIFO_MODE_MASK   0x01C0u
#define HEARTRATE13_SLOT_EN_SLOTB_EN_MASK   0x0020u
#define HEARTRATE13_SLOT_EN_SLOTA_FIFO_MODE_MASK   0x001Cu
#define HEARTRATE13_SLOT_EN_SLOTA_EN_MASK   0x0001u
#define HEARTRATE13_PD_LED_SELECT_SLOTB_PD_NC_NC_NC_NC   0x0000u
 Heart Rate 13 PD_LED_SELECT register settings.
#define HEARTRATE13_PD_LED_SELECT_SLOTB_PD_34_12_NC_NC   0x0100u
#define HEARTRATE13_PD_LED_SELECT_SLOTB_PD_78_56_NC_NC   0x0200u
#define HEARTRATE13_PD_LED_SELECT_SLOTB_PD_1234_NC_NC_NC   0x0300u
#define HEARTRATE13_PD_LED_SELECT_SLOTB_PD_5_6_7_8   0x0400u
#define HEARTRATE13_PD_LED_SELECT_SLOTB_PD_1_2_3_4   0x0500u
#define HEARTRATE13_PD_LED_SELECT_SLOTB_PD_34_56_NC_NC   0x0600u
#define HEARTRATE13_PD_LED_SELECT_SLOTB_PD_5678_NC_NC_NC   0x0700u
#define HEARTRATE13_PD_LED_SELECT_SLOTB_PD_SEL_MASK   0x0F00u
#define HEARTRATE13_PD_LED_SELECT_SLOTA_PD_NC_NC_NC_NC   0x0000u
#define HEARTRATE13_PD_LED_SELECT_SLOTA_PD_34_12_NC_NC   0x0010u
#define HEARTRATE13_PD_LED_SELECT_SLOTA_PD_78_56_NC_NC   0x0020u
#define HEARTRATE13_PD_LED_SELECT_SLOTA_PD_1234_NC_NC_NC   0x0030u
#define HEARTRATE13_PD_LED_SELECT_SLOTA_PD_5_6_7_8   0x0040u
#define HEARTRATE13_PD_LED_SELECT_SLOTA_PD_1_2_3_4   0x0050u
#define HEARTRATE13_PD_LED_SELECT_SLOTA_PD_34_56_NC_NC   0x0060u
#define HEARTRATE13_PD_LED_SELECT_SLOTA_PD_5678_NC_NC_NC   0x0070u
#define HEARTRATE13_PD_LED_SELECT_SLOTA_PD_SEL_MASK   0x00F0u
#define HEARTRATE13_PD_LED_SELECT_SLOTB_LED_FLOAT   0x0000u
#define HEARTRATE13_PD_LED_SELECT_SLOTB_LED_1   0x0004u
#define HEARTRATE13_PD_LED_SELECT_SLOTB_LED_2   0x0008u
#define HEARTRATE13_PD_LED_SELECT_SLOTB_LED_3   0x000Cu
#define HEARTRATE13_PD_LED_SELECT_SLOTB_LED_SEL_MASK   0x000Cu
#define HEARTRATE13_PD_LED_SELECT_SLOTA_LED_FLOAT   0x0000u
#define HEARTRATE13_PD_LED_SELECT_SLOTA_LED_1   0x0001u
#define HEARTRATE13_PD_LED_SELECT_SLOTA_LED_2   0x0002u
#define HEARTRATE13_PD_LED_SELECT_SLOTA_LED_3   0x0003u
#define HEARTRATE13_PD_LED_SELECT_SLOTA_LED_SEL_MASK   0x0003u
#define HEARTRATE13_LED_GREEN   1
 Heart Rate 13 photodiode LED selector.
#define HEARTRATE13_LED_IR   2
#define HEARTRATE13_LED_RED   3
#define HEARTRATE13_DEFAULT_LED   HEARTRATE13_LED_GREEN
#define HEARTRATE13_NUM_AVG_SLOTB_1   0x0000u
 Heart Rate 13 NUM_AVG register settings.
#define HEARTRATE13_NUM_AVG_SLOTB_2   0x0100u
#define HEARTRATE13_NUM_AVG_SLOTB_4   0x0200u
#define HEARTRATE13_NUM_AVG_SLOTB_8   0x0300u
#define HEARTRATE13_NUM_AVG_SLOTB_16   0x0400u
#define HEARTRATE13_NUM_AVG_SLOTB_32   0x0500u
#define HEARTRATE13_NUM_AVG_SLOTB_64   0x0600u
#define HEARTRATE13_NUM_AVG_SLOTB_128   0x0700u
#define HEARTRATE13_NUM_AVG_SLOTB_MASK   0x0700u
#define HEARTRATE13_NUM_AVG_SLOTA_1   0x0000u
#define HEARTRATE13_NUM_AVG_SLOTA_2   0x0010u
#define HEARTRATE13_NUM_AVG_SLOTA_4   0x0020u
#define HEARTRATE13_NUM_AVG_SLOTA_8   0x0030u
#define HEARTRATE13_NUM_AVG_SLOTA_16   0x0040u
#define HEARTRATE13_NUM_AVG_SLOTA_32   0x0050u
#define HEARTRATE13_NUM_AVG_SLOTA_64   0x0060u
#define HEARTRATE13_NUM_AVG_SLOTA_128   0x0070u
#define HEARTRATE13_NUM_AVG_SLOTA_MASK   0x0070u
#define HEARTRATE13_ILEDX_COARSE_RESERVED   0x1000u
 Heart Rate 13 ILEDx_COARSE register settings.
#define HEARTRATE13_ILEDX_COARSE_SCALE_10_PCT   0x0000u
#define HEARTRATE13_ILEDX_COARSE_SCALE_100_PCT   0x2000u
#define HEARTRATE13_ILEDX_COARSE_SCALE_MASK   0x2000u
#define HEARTRATE13_ILEDX_COARSE_SLEW_MIN   0x0000u
#define HEARTRATE13_ILEDX_COARSE_SLEW_MAX   0x0070u
#define HEARTRATE13_ILEDX_COARSE_SLEW_MASK   0x0070u
#define HEARTRATE13_ILEDX_COARSE_COARSE_MIN   0x0000u
#define HEARTRATE13_ILEDX_COARSE_COARSE_MAX   0x000Fu
#define HEARTRATE13_ILEDX_COARSE_COARSE_MASK   0x000Fu
#define HEARTRATE13_SLOTA_NUMPULSES_PULSES_8   0x0800u
 Heart Rate 13 SLOTA_NUMPULSES register settings.
#define HEARTRATE13_SLOTA_NUMPULSES_PULSES_MASK   0xFF00u
#define HEARTRATE13_SLOTA_NUMPULSES_PERIOD_15_US   0x000Eu
#define HEARTRATE13_SLOTA_NUMPULSES_PERIOD_MASK   0x00FFu
#define HEARTRATE13_SLOTA_AFE_WINDOW_WIDTH_4_US   0x2000u
 Heart Rate 13 SLOTA_AFE_WINDOW register settings.
#define HEARTRATE13_SLOTA_AFE_WINDOW_WIDTH_MASK   0xF800u
#define HEARTRATE13_SLOTA_AFE_WINDOW_OFFSET_23_5_US   0x02F0u
#define HEARTRATE13_SLOTA_AFE_WINDOW_OFFSET_MASK   0x07FFu
#define HEARTRATE13_INT_OSC   32000u
 Heart Rate 13 FSAMPLE register settings.
#define HEARTRATE13_FSAMPLE_1000_HZ   1000u
#define HEARTRATE13_FSAMPLE_MAX   2000u
#define HEARTRATE13_SW_RESET   0x0001u
 Heart Rate 13 SW_RESET register settings.
#define HEARTRATE13_MODE_STANDBY   0x0000u
 Heart Rate 13 MODE register settings.
#define HEARTRATE13_MODE_PROGRAM   0x0001u
#define HEARTRATE13_MODE_NORMAL   0x0002u
#define HEARTRATE13_STATUS_FIFO_SAMPLES_MASK   0xFF00u
 Heart Rate 13 STATUS register settings.
#define HEARTRATE13_STATUS_SLOTB_INT_MASK   0x0040u
#define HEARTRATE13_STATUS_SLOTA_INT_MASK   0x0020u
#define HEARTRATE13_STATUS_CLEAR   0xFFFFu
#define HEARTRATE13_TIMEOUT_MS   5000u
 Heart Rate 13 timeout value for data ready.
#define HEARTRATE13_DEVICE_ID   0x16
 Heart Rate 13 device ID value.
#define HEARTRATE13_DEVICE_ID_MASK   0xFF
#define HEARTRATE13_DEVICE_ADDRESS   0x64
 Heart Rate 13 device address setting.
#define HEARTRATE13_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  heartrate13_return_value_t { HEARTRATE13_OK = 0 , HEARTRATE13_ERROR = -1 }
 Heart Rate 13 Click return value data. More...

Functions

void heartrate13_cfg_setup (heartrate13_cfg_t *cfg)
 Heart Rate 13 configuration object setup function.
err_t heartrate13_init (heartrate13_t *ctx, heartrate13_cfg_t *cfg)
 Heart Rate 13 initialization function.
err_t heartrate13_default_cfg (heartrate13_t *ctx)
 Heart Rate 13 default configuration function.
err_t heartrate13_write_register (heartrate13_t *ctx, uint8_t reg, uint16_t data_in)
 Heart Rate 13 write register function.
err_t heartrate13_read_register (heartrate13_t *ctx, uint8_t reg, uint16_t *data_out)
 Heart Rate 13 read register function.
err_t heartrate13_check_communication (heartrate13_t *ctx)
 Heart Rate 13 check communication function.
uint8_t heartrate13_get_io0_pin (heartrate13_t *ctx)
 Heart Rate 13 get io0 function.
uint8_t heartrate13_get_io1_pin (heartrate13_t *ctx)
 Heart Rate 13 get io1 function.
err_t heartrate13_sw_reset (heartrate13_t *ctx)
 Heart Rate 13 sw reset function.
err_t heartrate13_set_mode (heartrate13_t *ctx, uint8_t mode)
 Heart Rate 13 set mode function.
err_t heartrate13_set_adc_fsample (heartrate13_t *ctx, uint16_t freq_hz)
 Heart Rate 13 set adc fsample function.
err_t heartrate13_clear_status (heartrate13_t *ctx)
 Heart Rate 13 clear status function.
err_t heartrate13_wait_data_ready (heartrate13_t *ctx)
 Heart Rate 13 wait data ready function.
err_t heartrate13_get_pd_data (heartrate13_t *ctx, heartrate13_pd_data_t *pd_data)
 Heart Rate 13 get pd data function.

Detailed Description

This file contains API for Heart Rate 13 Click Driver.

Enumeration Type Documentation

◆ heartrate13_return_value_t

Heart Rate 13 Click return value data.

Predefined enum values for driver return values.

Enumerator
HEARTRATE13_OK 
HEARTRATE13_ERROR